Skip to content

Conversation

@rsmithlal
Copy link
Member

@rsmithlal rsmithlal commented Nov 21, 2025

This pull request introduces several improvements and refactors across documentation, navigation, and styling, with a focus on standardizing page creation, enhancing markdown rendering, and updating best practices documentation. The most significant changes include the addition of a new documentation builder, refactoring navigation page creation to use page blocks, improved markdown content styling, and updates to RSpec best practices in documentation. Legacy CI configuration files have also been removed.

Documentation & Navigation Improvements

  • Added DocumentationBuilder to automate navigation and page creation for markdown documentation files in the docs/ directory. This builder generates navigation structure and documentation pages, associating markdown content with navigation areas. (app/builders/better_together/documentation_builder.rb)
  • Refactored navigation and footer page creation to use page_blocks_attributes with BetterTogether::Content::Template blocks instead of the legacy template attribute. Added new static pages such as "Cookie Policy" and contributor agreements for better compliance and organization. (app/builders/better_together/navigation_builder.rb) [1] [2] [3]

Styling Enhancements

  • Added comprehensive GitHub-flavored markdown styles to .markdown-content for headings, lists, code, tables, blockquotes, and more, improving readability and consistency of rendered documentation. (app/assets/stylesheets/better_together/content_blocks.scss)

Documentation Updates

  • Updated AGENTS.md and .github/copilot-instructions.md to include RSpec best practices, such as using named subjects for complex matchers, requiring reasons for pending tests, and guidance on matcher usage. [1] [2]

Cleanup

  • Removed legacy CI configuration files: .travis.yml and .coveralls.yml, reflecting migration away from Travis and Coveralls. [1] [2]

…Content Contributor Agreement, Cookie Policy, Privacy Policy, and Terms of Service for improved clarity
…support, and PIPEDA compliance

- Created a new Platform Administration Guide detailing roles, responsibilities, and dashboard features.
- Added a Security and Privacy Management guide outlining principles, access control, data protection, and incident response.
- Introduced User Support Procedures to streamline support requests, ticket management, and escalation processes.
- Documented PIPEDA compliance updates in privacy policy and cookie consent agreement, ensuring adherence to Canadian privacy laws.
- Updated the Table of Contents to reflect new documentation structure and added relevant links.
- Create a new spec for BetterTogether::Content::Template to test associations, validations, and methods.
- Enhance BetterTogether::Page spec to include tests for template blocks and attributes in indexed JSON.
- Implement request specs for markdown content block previews, covering various markdown features and error handling.
- Add service specs for BetterTogether::MarkdownRendererService, ensuring proper rendering of markdown to HTML and plain text.
- Introduce service specs for BetterTogether::TemplateRendererService, validating rendering for all locales and error handling.
- Create view specs for markdown fields and block types, ensuring proper rendering and accessibility.
- Created factories for BetterTogether content types: Hero, Html, Image, RichText, Css, and Link.
- Implemented RSpec tests for each content model, covering associations, validations, and instance methods.
- Added support for translations and custom attributes in content models.
- Ensured Active Storage attachments are validated and tested for Image model.
- Established nested attributes for PlatformBlock to integrate with BetterTogether platforms.
- Enhanced testing for Action Text integration in RichText model.
…ccounts, website links, and associated models with validations and associations
…leted phases, and detailed coverage analysis
…pletion of background jobs and their coverage
…dStepsController, TranslationsController, and ExternalLinkIconSanitizer

- Implement tests for PlatformInvitationMailer to verify email content and behavior with various scenarios.
- Create comprehensive specs for ReportsController to ensure metrics are correctly assigned and returned.
- Add tests for SetupWizardStepsController to validate platform and admin creation processes.
- Implement tests for TranslationsController to ensure translation functionality works as expected.
- Add specs for ExternalLinkIconSanitizer to verify proper sanitization of links and icon rendering.
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants